<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
  <meta name="description" content="API docs for the generate method from the UuidV5 class, for the Dart programming language.">
  <title>generate method - UuidV5 class - v5 library - Dart API</title>


  
  <link rel="preconnect" href="https://fonts.gstatic.com">
  <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
  <link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@48,400,0,0" rel="stylesheet">
  
  <link rel="stylesheet" href="../../static-assets/github.css?v1">
  <link rel="stylesheet" href="../../static-assets/styles.css?v1">
  <link rel="icon" href="../../static-assets/favicon.png?v1">

  
</head>


<body data-base-href="../../" data-using-base-href="false" class="light-theme">

<div id="overlay-under-drawer"></div>

<header id="title">
  <span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
  <ol class="breadcrumbs gt-separated dark hidden-xs">
    <li><a href="../../index.html">uuid</a></li>
    <li><a href="../../v5/v5-library.html">v5</a></li>
    <li><a href="../../v5/UuidV5-class.html">UuidV5</a></li>
    <li class="self-crumb">generate method</li>
  </ol>
  <div class="self-name">generate</div>
  <form class="search navbar-right" role="search">
    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
  <div class="toggle" id="theme-button">
    <label for="theme">
      <input type="checkbox" id="theme" value="light-theme">
      <span id="dark-theme-button" class="material-symbols-outlined">
        brightness_4
      </span>
      <span id="light-theme-button" class="material-symbols-outlined">
        brightness_5
      </span>
    </label>
  </div>
</header>
<main>

  <div
      id="dartdoc-main-content"
      class="main-content"
      data-above-sidebar="v5&#47;UuidV5-class-sidebar.html"
      data-below-sidebar="">
      <div>
<h1><span class="kind-method">generate</span> method 
</h1></div>

    <section class="multi-line-signature">
      

<span class="returntype"><a href="https://api.dart.dev/stable/3.1.3/dart-core/String-class.html">String</a></span>
<span class="name ">generate</span>(<wbr><ol class="parameter-list"><li><span class="parameter" id="generate-param-namespace"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.1.3/dart-core/String-class.html">String</a>?</span> <span class="parameter-name">namespace</span>, </span></li>
<li><span class="parameter" id="generate-param-name"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.1.3/dart-core/String-class.html">String</a>?</span> <span class="parameter-name">name</span>, </span></li>
<li><span class="parameter" id="generate-param-options">{<span class="type-annotation"><a href="../../data/V5Options-class.html">V5Options</a>?</span> <span class="parameter-name">options</span>}</span></li>
</ol>)

      

    </section>
    
<section class="desc markdown">
  <p>v5() Generates a namspace &amp; name-based version 5 UUID</p>
<p>By default it will generate a string based on a provided uuid namespace and
name, and will return a string.</p>
<p>The first argument is an options map that takes various configuration
options detailed in the readme.</p>
<p><a href="http://tools.ietf.org/html/rfc4122.html#section-4.4">http://tools.ietf.org/html/rfc4122.html#section-4.4</a></p>
</section>


    
<section class="summary source-code" id="source">
  <h2><span>Implementation</span></h2>
  <pre class="language-dart"><code class="language-dart">String generate(String? namespace, String? name, {V5Options? options}) {
  &#47;&#47; Check if user wants a random namespace generated by v4() or a NIL namespace.
  var useRandom = options?.randomNamespace ?? true;

  &#47;&#47; If useRandom is true, generate UUIDv4, else use NIL
  var blankNS = useRandom
      ? UuidV4(goptions: goptions).generate(options: options?.v4options)
      : Namespace.NIL;

  &#47;&#47; Use provided namespace, or use whatever is decided by options.
  namespace = (namespace != null) ? namespace : blankNS;

  &#47;&#47; Use provided name,
  name = (name != null) ? name : &#39;&#39;;

  &#47;&#47; Convert namespace UUID to Byte List
  var bytes = UuidParsing.parse(namespace);

  &#47;&#47; Convert name to a list of bytes
  var nameBytes = &lt;int&gt;[];
  for (var singleChar in name.codeUnits) {
    nameBytes.add(singleChar);
  }

  &#47;&#47; Generate SHA1 using namespace concatenated with name
  var hashBytes = crypto.sha1.convert([...bytes, ...nameBytes]).bytes;

  &#47;&#47; per 4.4, set bits for version and clockSeq high and reserved
  hashBytes[6] = (hashBytes[6] &amp; 0x0f) | 0x50;
  hashBytes[8] = (hashBytes[8] &amp; 0x3f) | 0x80;

  return UuidParsing.unparse(hashBytes.sublist(0, 16));
}</code></pre>
</section>


  </div> <!-- /.main-content -->

  <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
    <!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
<header id="header-search-sidebar" class="hidden-l">
  <form class="search-sidebar" role="search">
    <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
</header>

<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
    <li><a href="../../index.html">uuid</a></li>
    <li><a href="../../v5/v5-library.html">v5</a></li>
    <li><a href="../../v5/UuidV5-class.html">UuidV5</a></li>
    <li class="self-crumb">generate method</li>
</ol>


    <h5>UuidV5 class</h5>
  </div><!--/.sidebar-offcanvas-->

  <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
  </div><!--/.sidebar-offcanvas-->

</main>

<footer>
  <span class="no-break">
    uuid
      4.2.1
  </span>

  
</footer>



<script src="../../static-assets/highlight.pack.js?v1"></script>
<script src="../../static-assets/docs.dart.js"></script>



</body>

</html>

